home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 26 / Cream of the Crop 26.iso / utility / filup707.zip / FILUPDAT.DOC < prev    next >
Text File  |  1997-07-31  |  9KB  |  214 lines
  1. FILUPDAT.DOC                           1                           Jul 31, 1997
  2.  
  3. WIN95 AND WINNT NOTICE:  As with most DOS-based utilities, this program doesn't
  4. understand the weird subdirectories, long filenames,  invalid  characters  that
  5. are possible under Windows 95 and Windows/NT.   Both  operating  systems  alias
  6. long filenames into names like MYFILE~1.TXT and you will need  to  specify  the
  7. aliased versions of file names to process  them.   Under  some  file  structure
  8. systems in NT, the program may not work at all.
  9.  
  10. This program is designed to make updating of files and source code both  easier
  11. and quicker.  It compares a list of files in a source directory to  a  list  of
  12. files in a destination directory and copies any files that are newer  than  the
  13. ones found in the destination directory.  This is quicker than copying  all  of
  14. the files with DOS wildcard commands and cleaner than copying  everything  when
  15. you only want some of the files in the destination area.
  16.  
  17.  
  18. The control card file:
  19.  
  20. FILUPDAT requires an ASCII control card file to be created.  The  control  card
  21. file can consist of five types of records:
  22.  
  23. (1)  comments:  These records start with semi-colons or colons  or  are  blank.
  24.      They are available primarily for documenting what you're doing.
  25.  
  26. (2)  source directory:  These records start with  "-S"  (or  "-F"  for  "from")
  27.      followed by the path to copy the files from.  Something  like  "-SC:\QB45"
  28.      works fine.
  29.  
  30. (3)  destination directory:  These records start with "-D" (or "-T"  for  "to")
  31.      followed  by  the   path   to   copy   the   files   to.    For   example,
  32.      "-DJ:\EBBNEW\DOCS".
  33.  
  34. (4)  exclusion specification:  These records start  with  "-X"  followed  by  a
  35.      space and one or more filespecs (typically with wildcards).  For  example,
  36.      your main file  specification  may  be  "*.*"  but  you  can  exclude  any
  37.      QuickBASIC source code files or object modules by including  a  "-X  *.BAS
  38.      *.OBJ" statement.
  39.  
  40. (5)  files:  These records have a single file name (for example, "EBBFFILE.WP")
  41.      that is to  be  copied  from  the  source  directory  to  the  destination
  42.      directory. File specifications can include standard DOS wildcards ("*" and
  43.      "?").  A comment can follow the file name provided the comment starts with
  44.      a colon or a semi-colon.
  45.  
  46.  
  47. FILUPDAT.DOC                           2                           Jul 31, 1997
  48.  
  49. Source and destination cards can be changed throughout the control  card  file.
  50. Files are copied based on the most recent source/destination  card  before  the
  51. file card.  Changing either the source or destination will reset the  exclusion
  52. specification so you have to respecify the -X card if desired.
  53.  
  54. Also note that cards are processed sequentially.  The  exclusion  specification
  55. card only affects file name card(s) which occur after it.
  56.  
  57.  
  58. A sample control card file might look like this:
  59.  
  60.         ; Sample file
  61.         -SC:\PDOX
  62.         -DJ:\EBBNEW\PRGS
  63.         CUSTOM.SC
  64.         ADDRESS.SC
  65.         ZIPCODE.SC
  66.         ; Specifying another source file path; destination still the same
  67.         -SC:\MINE
  68.         NEWUSER.SC
  69.  
  70.  
  71. Specifying parameters:
  72.  
  73. Parameters for this program can be set in the following ways.  The last setting
  74. encountered always wins:
  75.   - Read from an *.INI file (see BRUCEINI.DOC file),
  76.   - Through the use of an environmental variable (SET FILUPDAT=whatever), or
  77.   - From the command line (see "Syntax" below)
  78.  
  79.  
  80.  
  81. FILUPDAT.DOC                           3                           Jul 31, 1997
  82.  
  83. Syntax:
  84.  
  85.     FILUPDAT { ctlfile | /Cctlfile } [ /-A ] [ /-R ] [ /CLONE ]
  86.       [ /Flist_file [ /OVERWRITE | /APPEND | /-OVERWRITE | /OVERASK ] ]
  87.       [ /FULL ] [ /ABORT | /SKIP | /CREATE ] [ /Q ]
  88.       [ /MONO ] [ /Iinitfile | /-I ] [ /-ENV ] [ /? ]
  89.  
  90. where:
  91.  
  92. "ctlfile" or "/Cctlfile" is the name of the control  statement  file.   It  can
  93. include path information if necessary.
  94.  
  95. "/-A" says to copy files to the destination subdirectories only if a version of
  96. the file is already there.  Initially defaults to "/A".
  97.  
  98. "/A" says that  a  file  can  be  added  to  the  destination  subdirectory  if
  99. necessary.  This is initially the default.
  100.  
  101. "/-R" says to copy a file to the destination subdirectories only if  a  version
  102. of the file is not already there.  Initially defaults to "/R".
  103.  
  104. "/R" says that if a file already exists in the destination  subdirectory,  feel
  105. free to replace it.  This is initially the default.
  106.  
  107. "/CLONE" copies every file  to  the  destination  subdirectory,  even  if  they
  108. appear, on the basis of the normal date and time and size  checks,  to  be  the
  109. same file.  Initially defaults to "/-CLONE".
  110.  
  111. "/-CLONE" only copies files when there is a difference between the source  file
  112. and the destination one.  This is initially the default.
  113.  
  114. "/Flist_file" says you want a text file created which tells you what files were
  115. considered and what happened to each of them.  The "list_file" is the  name  of
  116. the file.  This is primarily used for checking the operation  of  the  utility.
  117. The file name can include path information if  necessary;  it  must  contain  a
  118. period (use something like "/FTEST." if no extension is used).
  119.  
  120. "/OVERWRITE" says that if the list_file already  exists,  don't  prompt  before
  121. overwriting it.
  122.  
  123. "/APPEND" says to append to the list_file if it already exists.
  124.  
  125. "/-OVERWRITE" says to abort if the output file exists already.
  126.  
  127. "/OVERASK" says to prompt if the output  file  exists  already.   This  is  the
  128. default.
  129.  
  130. "/FULL" says to write out full comparison information in the  list_file.   This
  131. is primarily for debugging purposes but it includes the numeric  representation
  132. of the date and time for both the source and destination files.
  133.  
  134.  
  135. FILUPDAT.DOC                           4                           Jul 31, 1997
  136.  
  137. "/ABORT" says that if any source or destination subdirectory is  missing,  give
  138. an error message and abort the program.  This is initially the default.
  139.  
  140. "/SKIP" says that if any source or destination subdirectory is missing, give an
  141. error message, skip all files for that specification,  but  otherwise  continue
  142. running the program.
  143.  
  144. "/CREATE" says that if a destination subdirectory is  missing,  give  an  error
  145. message and try to create the subdirectory.  If successful,  copy  the  desired
  146. files to it.  If not successful, skip all  files  for  that  specification  but
  147. otherwise continue running the program.  If  the  source  subdirectory  is  not
  148. found, the program will operate as if /SKIP was specified.
  149.  
  150. "/Q" turns off the file-by-file status reporting.
  151.  
  152. "/MONO" (or "/-COLOR") does not  try  to  override  screen  colors.   Initially
  153. defaults to "/COLOR".
  154.  
  155. "/COLOR" (or  "/-MONO")  allows  screen  colors  to  be  overridden.   This  is
  156. initially the default.
  157.  
  158. "/Iinitfile" says to read an initialization file with the file name "initfile".
  159. The file specification *must* contain a period.  Initfiles are described in the
  160. BRUCEINI.DOC file.  Initially defaults to "/IFILUPDAT.INI".
  161.  
  162. "/-I" (or "/INULL") says to skip loading the initialization file.
  163.  
  164. "/ENV" says to look for %var% occurrences  in  the  command  line  and  try  to
  165. resolve any apparent environmental variable references.  See  BRUCEINI.DOC  for
  166. more information.  This is initially the default.
  167.  
  168. "/-ENV" says to skip resolving apparent %var% occurrences in the command  line.
  169. Initially defaults to "/ENV".
  170.  
  171. "/?" or "/HELP" or "HELP" shows you the syntax for the command.
  172.  
  173.  
  174.  
  175. FILUPDAT.DOC                           5                           Jul 31, 1997
  176.  
  177. Return codes:
  178.  
  179. FILUPDAT returns the following ERRORLEVEL codes:
  180.  
  181.         0 = no problems
  182.       250 = operation aborted by pressing Escape
  183.       251 = invalid control file or bad drive/subdirectory specification
  184.       252 = copy failed
  185.       253 = no files found to copy
  186.       255 = syntax problems, or /? requested
  187.  
  188.  
  189. Author:
  190.  
  191.                         Bruce Guthrie
  192.                         Room H-4885
  193.                         U.S. Dept of Commerce/ESA/STAT-USA
  194.                         Washington, DC 20230
  195.  
  196.                         voice: (202) 482-3234
  197.                         e-mail: bguthrie@doc.gov
  198.  
  199. You  may  freely  copy  and  re-distribute  this  program;  however,  the  U.S.
  200. Department of Commerce neither guarantees  nor  assures  compatibility  of  the
  201. program with all computer software or hardware.
  202.  
  203. Additional information about this and other Bruce Guthrie programs can be found
  204. in the file BRUCE.DOC which should be included in the original ZIP  file.   The
  205. recent change history for this and  the  other  programs  is  provided  in  the
  206. HISTORY.ymm file which should be in the same ZIP file where "y" is replaced  by
  207. the last digit of the year and "mm" is the two  digit  month  of  the  release;
  208. HISTORY.611 came out in November 1996.  This same naming convention is used  in
  209. naming the ZIP file (FILUPymm.ZIP) that this program was included in.
  210.  
  211. Please provide an Internet e-mail address on all correspondence.
  212.  
  213. 
  214.